home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audiofile / AFsetloopstart.z / AFsetloopstart
Encoding:
Text File  |  2002-10-03  |  8.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4. aaaaffffSSSSeeeettttLLLLooooooooppppSSSSttttaaaarrrrtttt((((3333ddddmmmm))))                                        aaaaffffSSSSeeeettttLLLLooooooooppppSSSSttttaaaarrrrtttt((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      afSetLoopStart, afSetLoopEnd, afSetLoopMode, afSetLoopTrack - set the
  10.      start/end markers, play mode, and track in an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee structure for
  11.      a specified loop.
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiiooooffffiiiilllleeee....hhhh>>>>
  15.  
  16.      vvvvooooiiiidddd aaaaffffSSSSeeeettttLLLLooooooooppppSSSSttttaaaarrrrtttt((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee,,,, iiiinnnntttt iiiinnnnssssttttiiiidddd,,,,
  17.                                 iiiinnnntttt llllooooooooppppiiiidddd,,,, iiiinnnntttt mmmmaaaarrrrkkkkiiiidddd))))
  18.  
  19.      vvvvooooiiiidddd aaaaffffSSSSeeeettttLLLLooooooooppppEEEEnnnndddd((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee,,,,   iiiinnnntttt iiiinnnnssssttttiiiidddd,,,,
  20.                                 iiiinnnntttt llllooooooooppppiiiidddd,,,, iiiinnnntttt mmmmaaaarrrrkkkkiiiidddd))))
  21.  
  22.      vvvvooooiiiidddd aaaaffffSSSSeeeettttLLLLooooooooppppTTTTrrrraaaacccckkkk((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee,,,, iiiinnnntttt iiiinnnnssssttttiiiidddd,,,,
  23.                                 iiiinnnntttt llllooooooooppppiiiidddd,,,, iiiinnnntttt ttttrrrraaaacccckkkkiiiidddd))))
  24.  
  25.      vvvvooooiiiidddd aaaaffffSSSSeeeettttLLLLooooooooppppMMMMooooddddeeee((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee,,,,  iiiinnnntttt iiiinnnnssssttttiiiidddd,,,,
  26.                                 iiiinnnntttt llllooooooooppppiiiidddd,,,, iiiinnnntttt mmmmooooddddeeee))))
  27.  
  28. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  29.      _s_e_t_u_p     is an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee structure, previously created by a call to
  30.                aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm) or aaaaffffOOOOppppeeeennnnFFFFDDDD(3dm), which opened an audio file
  31.                for write access.
  32.  
  33.      _i_n_s_t_i_d    is a positive integer value which identifies a chunk of
  34.                instrument parameters.  Since the number of supported inst
  35.                chunks varies with file format, applications should always
  36.                retrieve this value via afGetInstIDs(3dm).
  37.  
  38.      _l_o_o_p_i_d    is a positive integer value which identifies a loop stored in
  39.                the instrument configuration given by _i_n_s_t_i_d.
  40.  
  41.      _m_a_r_k_i_d    is a positive integer marker value which identifies a marker
  42.                associated with the track given by _t_r_a_c_k_i_d.
  43.  
  44.                The start and end sample frames of a loop are indicated by
  45.                marker positions stored in marker structures.
  46.  
  47.      _t_r_a_c_k_i_d   is a positive integer ID indicating which audio track in _f_i_l_e
  48.                will contain the specified loop.
  49.  
  50.                Since all currently supported audio file formats contain a
  51.                single audio track per file, the constant value
  52.                AAAAFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____TTTTRRRRAAAACCCCKKKK should always be used here for now.
  53.  
  54.      _m_o_d_e      is a constant integer indicates the play mode for the loop.
  55.  
  56. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  57.      These routines allow you to specify loops in an audio track.  Each takes
  58.      a _l_o_o_p_i_d argument which provides a handle to a loop structure.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaaffffSSSSeeeettttLLLLooooooooppppSSSSttttaaaarrrrtttt((((3333ddddmmmm))))                                        aaaaffffSSSSeeeettttLLLLooooooooppppSSSSttttaaaarrrrtttt((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      In an AIFF-C (or AIFF) file, the instrument chunk, denoted by integer
  75.      constant AAAAFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____IIIINNNNSSSSTTTT, contains two loops - a "sustain" loop and a
  76.      "release" loop.
  77.  
  78.      You can obtain loop ID's for the two loops by calling aaaaffffGGGGeeeettttLLLLooooooooppppIIIIDDDDssss(3dm)
  79.      after you've opened an audio file, or you can supply your own loop ID's
  80.      by calling aaaaffffIIIInnnniiiittttLLLLooooooooppppIIIIDDDDssss(3dm) before the file is opened.
  81.  
  82.      For AIFF and AIFF-C files you map your loop ID list to the
  83.      sustain/release loops for the default instrument by calling
  84.      aaaaffffSSSSeeeettttIIIInnnnssssttttPPPPaaaarrrraaaammmmLLLLoooonnnngggg(3dm).
  85.  
  86.      The start and end sample frames for a loop are indicated by marker
  87.      structures. An AIFF-C (or AIFF) track may contain one or more marker
  88.      structures.  A marker structure stores a location in an audio track.
  89.  
  90.      To store two loops, you typically need four markers, two for each loop.
  91.      See the man page for afSetMarkPosition(3dm) for information about how you
  92.      assign a marker to a specific location in an audio track.
  93.  
  94.      aaaaffffSSSSeeeettttLLLLooooooooppppSSSSttttaaaarrrrtttt(((()))) set the start frame marker for a given loop in the
  95.      specified audio track.  aaaaffffSSSSeeeettttLLLLooooooooppppEEEEnnnndddd sets the end frame marker for a
  96.      loop.  The loop is specified by the value of _l_o_o_p_i_d, a loop identifier
  97.      which was previously configured into the audio track by a call to
  98.      aaaaffffIIIInnnniiiittttLLLLooooooooppppIIIIDDDDssss(((()))).
  99.  
  100.      aaaaffffSSSSeeeettttLLLLooooooooppppTTTTrrrraaaacccckkkk(((()))) is a placeholder routine which specifies an audio track
  101.      in a file for a loop.  Since an AIFF-C (AIFF) file always contain one
  102.      audio track, the loops automatically map to AAAAFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____TTTTRRRRAAAACCCCKKKK.
  103.  
  104.      aaaaffffSSSSeeeettttLLLLooooooooppppMMMMooooddddeeee(((()))) sets the play mode for a loop.  The following modes are
  105.      supported:
  106.  
  107.                AF_LOOP_MODE_NOLOOP causes the loop to be ignored
  108.                AF_LOOP_MODE_FORW   forward loop
  109.                AF_LOOP_MODE_FORWBAKW    forward/backward loop
  110.  
  111.  
  112. NNNNOOOOTTTTEEEESSSS
  113.      It is now possible to set the loop start and end frame directly without
  114.      using the associated markers (see aaaaffffSSSSeeeettttLLLLooooooooppppSSSSttttaaaarrrrttttFFFFrrrraaaammmmeeee(3dm)).  This is
  115.      useful and necessary for audio file formats which support loops which are
  116.      independent of any markers, and for formats which support loops but which
  117.      do not support markers at all.  For formats which always associate loops
  118.      and markers, such as AAAAIIIIFFFFFFFF(4) and WWWWAAAAVVVVEEEE(4), aaaaffffSSSSeeeettttLLLLooooooooppppSSSSttttaaaarrrrtttt(((()))) must be used
  119.      or the file update will fail.
  120.  
  121. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  122.      afNewFileSetup(3dm), afOpenFile(3dm), afInitLoopIDs(3dm),
  123.      afGetLoopIDs(3dm), afInitMarkIDs(3dm), afSetMarkPosition(3dm)
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.